API endpoints

Air conditioners

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Cooling-only ductless air conditioners: arrow image

Path

/api/v1/air-conditioners/non-duct/cooling-only-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Cooling-only ductless air conditioners: energy label

The label must be at least 100mm x 200mm when printed.

Path

/api/v1/air-conditioners/non-duct/cooling-only-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
coolingEfficiencyRating Energy efficiency class for cooling.

Must be one of:
A+++
A++
A+
A
B
C
D
String
coolingModeDesignLoad Cooling mode: design load in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
coolingModeSeer Cooling mode: seasonal energy efficiency ratio (SEER value). This may be up to 2 digits long with an optional 1 decimal place. Number
coolingAnnualEnergyConsumption Annual energy consumption in kWh per year, for cooling. This may be up to 4 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power levels for outdoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "coolingEfficiencyRating": "A+++", "coolingModeDesignLoad": 1.1, "coolingModeSeer": 1.1, "coolingAnnualEnergyConsumption": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1 }

Cooling-only single or double duct air conditioners: arrow image

Path

/api/v1/air-conditioners/single-or-double-duct/cooling-only-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Cooling-only single or double duct air conditioners: energy label

The label must be at least 100mm x 200mm when printed.

Path

/api/v1/air-conditioners/single-or-double-duct/cooling-only-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
coolingEfficiencyRating Energy efficiency class for cooling.

Must be one of:
A+++
A++
A+
A
B
C
D
String
coolingKw Rated capacity for cooling in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
eerRated EER rated value. This may be up to 1 digit long with an optional 1 decimal place. Number
coolingHourlyEnergyConsumption Hourly energy consumption in kWh per 60 minutes, rounded up to the nearest integer. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "coolingEfficiencyRating": "A+++", "coolingKw": 1.1, "eerRated": 1.1, "coolingHourlyEnergyConsumption": 1, "soundPowerLevelIndoors": 1 }

Heating-only ductless air conditioners: arrow image

Path

/api/v1/air-conditioners/non-duct/heating-only-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Heating-only ductless air conditioners: energy label

The label must be at least 100mm x 200mm when printed.

Path

/api/v1/air-conditioners/non-duct/heating-only-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
warmerConditions Is data available for warmer climate conditions? Boolean
warmerHeatingEfficiencyRating Energy efficiency class for Warmer heating season. Only required if warmerConditions is true.

Must be one of:
A+++
A++
A+
A
B
C
D
String
warmerHeatingDesignLoad Design load for heating in warmer climate conditions in kW. Only required if warmerConditions is true. This may be up to 2 digits long with an optional 1 decimal place. Number
warmerScop Seasonal coefficient of performance in warmer climate conditions (SCOP value). Only required if warmerConditions is true. This may be up to 1 digit long with an optional 1 decimal place. Number
warmerAnnualEnergyConsumption Annual energy consumption in kWh per year in warmer climate conditions. Only required if warmerConditions is true. This may be up to 4 digits long. Integer
colderConditions Is data available for colder climate conditions? Boolean
colderHeatingEfficiencyRating Energy efficiency class for Colder heating season. Only required if colderConditions is true.

Must be one of:
A+++
A++
A+
A
B
C
D
String
colderHeatingDesignLoad Design load for heating in colder climate conditions in kW. Only required if colderConditions is true. This may be up to 2 digits long with an optional 1 decimal place. Number
colderScop Seasonal coefficient of performance in colder climate conditions (SCOP value). Only required if colderConditions is true. This may be up to 1 digit long with an optional 1 decimal place. Number
colderAnnualEnergyConsumption Annual energy consumption in kWh per year in colder climate conditions. Only required if colderConditions is true. This may be up to 4 digits long. Integer
averageHeatingEfficiencyRating Energy efficiency class for Average heating season.

Must be one of:
A+++
A++
A+
A
B
C
D
String
averageHeatingDesignLoad Design load for heating in average climate conditions in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
averageScop Seasonal coefficient of performance in average climate conditions (SCOP value). This may be up to 1 digit long with an optional 1 decimal place. Number
averageAnnualEnergyConsumption Annual energy consumption in kWh per year in average climate conditions. This may be up to 4 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power levels for outdoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "warmerConditions": true, "warmerHeatingEfficiencyRating": "A+++", "warmerHeatingDesignLoad": 1.1, "warmerScop": 1.1, "warmerAnnualEnergyConsumption": 1, "colderConditions": true, "colderHeatingEfficiencyRating": "A+++", "colderHeatingDesignLoad": 1.1, "colderScop": 1.1, "colderAnnualEnergyConsumption": 1, "averageHeatingEfficiencyRating": "A+++", "averageHeatingDesignLoad": 1.1, "averageScop": 1.1, "averageAnnualEnergyConsumption": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1 }

Heating-only single or double duct air conditioners: arrow image

Path

/api/v1/air-conditioners/single-or-double-duct/heating-only-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Heating-only single or double duct air conditioners: energy label

The label must be at least 100mm x 200mm when printed.

Path

/api/v1/air-conditioners/single-or-double-duct/heating-only-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
heatingEfficiencyRating Energy efficiency class for heating.

Must be one of:
A+++
A++
A+
A
B
C
D
String
heatingKw Rated capacity for heating in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
copRated COPrated value. This may be up to 1 digit long with an optional 1 decimal place. Number
heatingHourlyEnergyConsumption Hourly energy consumption in kWh per 60 minutes, rounded up to the nearest integer. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "heatingEfficiencyRating": "A+++", "heatingKw": 1.1, "copRated": 1.1, "heatingHourlyEnergyConsumption": 1, "soundPowerLevelIndoors": 1 }

Reversible ductless air conditioners: arrow image

Path

/api/v1/air-conditioners/non-duct/reversible-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Reversible ductless air conditioners: energy label

The label must be at least 120mm x 210mm when printed

Path

/api/v1/air-conditioners/non-duct/reversible-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
warmerConditions Is data available for warmer climate conditions? Boolean
warmerHeatingEfficiencyRating Energy efficiency class for Warmer heating season. Only required if warmerConditions is true.

Must be one of:
A+++
A++
A+
A
B
C
D
String
warmerHeatingDesignLoad Design load for heating in warmer climate conditions in kW. Only required if warmerConditions is true. This may be up to 2 digits long with an optional 1 decimal place. Number
warmerScop Seasonal coefficient of performance in warmer climate conditions (SCOP value). Only required if warmerConditions is true. This may be up to 1 digit long with an optional 1 decimal place. Number
warmerAnnualEnergyConsumption Annual energy consumption in kWh per year in warmer climate conditions. Only required if warmerConditions is true. This may be up to 4 digits long. Integer
colderConditions Is data available for colder climate conditions? Boolean
colderHeatingEfficiencyRating Energy efficiency class for Colder heating season. Only required if colderConditions is true.

Must be one of:
A+++
A++
A+
A
B
C
D
String
colderHeatingDesignLoad Design load for heating in colder climate conditions in kW. Only required if colderConditions is true. This may be up to 2 digits long with an optional 1 decimal place. Number
colderScop Seasonal coefficient of performance in colder climate conditions (SCOP value). Only required if colderConditions is true. This may be up to 1 digit long with an optional 1 decimal place. Number
colderAnnualEnergyConsumption Annual energy consumption in kWh per year in colder climate conditions. Only required if colderConditions is true. This may be up to 4 digits long. Integer
coolingEfficiencyRating Energy efficiency class for cooling.

Must be one of:
A+++
A++
A+
A
B
C
D
String
coolingModeDesignLoad Cooling mode: design load in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
coolingModeSeer Cooling mode: seasonal energy efficiency ratio (SEER value) . This may be up to 2 digits long with an optional 1 decimal place. Number
coolingAnnualEnergyConsumption Annual energy consumption in kWh per year, for cooling. This may be up to 4 digits long. Integer
averageHeatingEfficiencyRating Energy efficiency class for Average heating season.

Must be one of:
A+++
A++
A+
A
B
C
D
String
averageHeatingDesignLoad Design load for heating in average climate conditions in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
averageScop Seasonal coefficient of performance in average climate conditions (SCOP value). This may be up to 1 digit long with an optional 1 decimal place. Number
averageAnnualEnergyConsumption Annual energy consumption in kWh per year in average climate conditions. This may be up to 4 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power levels for outdoor units expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "warmerConditions": true, "warmerHeatingEfficiencyRating": "A+++", "warmerHeatingDesignLoad": 1.1, "warmerScop": 1.1, "warmerAnnualEnergyConsumption": 1, "colderConditions": true, "colderHeatingEfficiencyRating": "A+++", "colderHeatingDesignLoad": 1.1, "colderScop": 1.1, "colderAnnualEnergyConsumption": 1, "coolingEfficiencyRating": "A+++", "coolingModeDesignLoad": 1.1, "coolingModeSeer": 1.1, "coolingAnnualEnergyConsumption": 1, "averageHeatingEfficiencyRating": "A+++", "averageHeatingDesignLoad": 1.1, "averageScop": 1.1, "averageAnnualEnergyConsumption": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1 }

Reversible single or double duct air conditioners: arrow image

Path

/api/v1/air-conditioners/single-or-double-duct/reversible-air-conditioners/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Reversible single or double duct air conditioners: energy label

The label must be at least 100mm x 200mm when printed.

Path

/api/v1/air-conditioners/single-or-double-duct/reversible-air-conditioners/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
coolingEfficiencyRating Energy efficiency class for cooling.

Must be one of:
A+++
A++
A+
A
B
C
D
String
coolingKw Rated capacity for cooling in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
eerRated EER rated value. This may be up to 1 digit long with an optional 1 decimal place. Number
coolingHourlyEnergyConsumption Hourly energy consumption for cooling in kWh per 60 minutes, rounded up to the nearest integer. This may be up to 2 digits long. Integer
heatingEfficiencyRating Energy efficiency class for heating.

Must be one of:
A+++
A++
A+
A
B
C
D
String
heatingKw Rated capacity for heating in kW. This may be up to 2 digits long with an optional 1 decimal place. Number
copRated COPrated value. This may be up to 1 digit long with an optional 1 decimal place. Number
heatingHourlyEnergyConsumption Hourly energy consumption for heating in kWh per 60 minutes, rounded up to the nearest integer. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power levels for indoor units expressed in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "coolingEfficiencyRating": "A+++", "coolingKw": 1.1, "eerRated": 1.1, "coolingHourlyEnergyConsumption": 1, "heatingEfficiencyRating": "A+++", "heatingKw": 1.1, "copRated": 1.1, "heatingHourlyEnergyConsumption": 1, "soundPowerLevelIndoors": 1 }